home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / batchut / rap101.zip / READ.ME < prev    next >
Text File  |  1989-10-06  |  7KB  |  165 lines
  1.  
  2.                    Supplemental Notes for RAP Release
  3.                       Version 1.01, May 1989
  4.  
  5.  
  6. Guide to files on this disk
  7.  
  8.      READ.ME        This file
  9.  
  10.      RAP.EXE        The RAP interpreter
  11.      SMALLRAP.EXE   The SmallRAP interpreter
  12.      LARGERAP.EXE   The LargeRAP interpreter
  13.      MENUCOL.RAP    A sample program (see below)
  14.      KEYMENU.RAP    A sample program (see below)
  15.      UPDATES.LST    List of updates to RAP since version 0.8
  16.  
  17.      COMMON.RAP     A compacted version of the COMMON subroutine library
  18.      COMMON.SRC     Complete RAP source code for the subroutine library
  19.      COMMON.HST     Maintenance history of COMMON.RAP
  20.      HELPGEN.EXE    The program to generate help (.HLP) files
  21.      DEMO.RAP       A program to demonstrate some COMMON.RAP functions
  22.      REFORMAT.RAP   The sample program explained in Chapter 4 of book
  23.      REFORMAT.TXT   Source help file for sample program
  24.      REFORMAT.HLP   Help file for sample program
  25.      REFORMAT.PTP   The PTP program executed by the sample RAP program
  26.      REFORMAT.BAT   A batch file to run the sample program
  27.      BARU.ITX       A sample data file for use with sample program
  28.  
  29.  
  30. Further notes about files on this disk
  31.  
  32. 1.  The RAP programming language and the three versions of its interpreter
  33.     are documented in full in The RAP Programming Language, by Richard A.
  34.     Strangfeld (Dallas, TX: Summer Institute of Linguistics, 1988, 258 pp.)
  35.  
  36. 2.  This disk contains two advanced sample programs.  The first, MENUCOL.RAP,
  37.     shows use of the advanced menu-option features together with ANSI screen
  38.     codes.  The second, KEYMENU.RAP, uses the as command, special keys, ANSI 
  39.     codes, an array, and the xi command to provide a different kind of menu.
  40.     These are both advanced examples; we don't suggest that you study them un-
  41.     til you are comfortable with the more straightforward examples in the book.
  42.  
  43. 3.  Readers who have used previous versions of RAP are strongly encouraged
  44.     to read UPDATES.LST.  It describes all bug fixes and enhancements since
  45.     the release of version 1.00.  It also describes the many feature changes
  46.     that were made in bringing the widely used pre-release version 0.8 to the
  47.     published standard of version 1.00.
  48.  
  49. 4.  The remaining files on the disk relate to the COMMON subroutine library.
  50.     It is fully documented in A Common Subroutine Library for RAP Programmers,
  51.     by Kirk H. Parker and Gary F. Simons (Dallas, TX: Summer Institute of
  52.     Linguistics, 1988, 102 pp.).
  53.  
  54. 5.  COMMON.SRC is executable RAP code.  it is the fully commented version of
  55.     the subroutine library.  COMMON.RAP has all of the comments stripped out
  56.     and all of the .define'd constants substituted in order to make it load
  57.     more quickly.
  58.  
  59. 6.  The current version of HELPGEN.EXE has a maximum input file size of about
  60.     45K.  This version does NOT detect multiple instances of the same topic
  61.     name.  As the output file is being generated, each topic name is written
  62.     to standard output.  This can be redirected to a file, sorted, and then
  63.     checked for duplicates.
  64.  
  65.  
  66. Features added to RAP
  67.  
  68. 1.  Before starting RAP, you may optionally set the screen type with the DOS 
  69.     environment variable SCREENTYPE.  If this variable exists and has the
  70.     value IBM, ANSI, or SHARP, $screentype will be set accordingly without
  71.     the normal screen test.  The command-line options /ibm, /ansi, and
  72.     /sharp still override this.  This applies only to normal and LargeRAP.
  73.  
  74.     Text display really is a lot faster with the IBM screentype than with the
  75.     ANSI, if you don't need special ANSI screen control.
  76.  
  77.  
  78. 2.  You need not use a double equals sign as a comparison operator.  RAP now
  79.     accepts a single equals.  Saying  if #n = 99  is the same as  if #n == 99.
  80.  
  81.     This change has one drawback:  the formerly-illegal assignment statement  
  82.     #a = #b = #c  is now legal, and it doesn't do what some might expect.
  83.     It does NOT set both #a and #b to match #c.  Instead, it works just like  
  84.     #a = #b == #c always did.  It compares #b with #c, and sets #a to 1 if 
  85.     they are equal and 0 if they are not.
  86.  
  87.  
  88. RAP documentation changes
  89.  
  90. 1.  The following error messages were not described in the documentation:
  91.  
  92.     File not open for writing
  93.  
  94.     This means what it says.  If you open a file in read-only mode (which is
  95.     the default), you can't write to it without closing and opening it again.
  96.  
  97.     Invalid or non-open file number
  98.  
  99.     In a close, read, rewind, seek, or write operation, you must specify the
  100.     descriptor of a file that you have opened with *open.  This message means
  101.     you have not done so, or you have closed the file in the meantime.
  102.  
  103.     Runaway string recursion
  104.  
  105.     In the unusual situation where a string variable has been assigned a value
  106.     identical to its name, evaluation of a string containing that variable
  107.     could put RAP in a loop.  RAP replaces the name, then sees the newly
  108.     placed name and replaces it, and so on.  To prevent an infinite loop,
  109.     RAP counts the number of times it makes replacements in a given string
  110.     evaluation.  When the number gets large, RAP concludes it has the
  111.     situation described, and stops with an error message.
  112.  
  113.     Unable to killf <filename>
  114.  
  115.     This message appears when a killf fails.  The most common causes are a
  116.     badly formed filename, a nonexistent file, a name of a directory instead
  117.     of a file, or a write-protected file.
  118.  
  119.  
  120. Known bugs in RAP
  121.  
  122. 1.  If the asterisk is left off the procedure name in a "numeric function"
  123.     or "string function" statement, RAP does not diagnose the problem very
  124.     well.  It reports something like "Unexpected unknown", among other things.  
  125.  
  126.     This is only a problem when your RAP program has the error mentioned, but
  127.     it's still less helpful than we'd like.
  128.  
  129. 2.  Contrary to the documentation, the menu facility does not automatically
  130.     repeat after executing a help-group.  You need to put in an explicit
  131.     repeat statement at the end of the help-group.
  132.  
  133.  
  134. Registration
  135.  
  136.     There is a registration form packaged with the RAP books and disk.  If
  137.     you fill it out and send it in, we'll be able to keep you informed of
  138.     improvements and bug fixes. If you don't, we'll never know you're there.
  139.     Please do send it in.
  140.  
  141.     If the form is missing, just drop us a note at the address below.  We'll
  142.     need to know the kind of computer you're using, which version of MS-DOS,
  143.     how much memory you have, the disk format you use, and your return 
  144.     address.
  145.  
  146.         Academic Computing -- RAP development
  147.         Summer Institute of Linguistics
  148.         7500 W. Camp Wisdom Rd.
  149.         Dallas, TX 75236
  150.  
  151.     If you have this disk but don't have the books, you can get them from
  152.     the Academic Book Center at the same address.  The retail price for the
  153.     set of two books with accompanying diskette including the latest version
  154.     of the software is $36.
  155.  
  156.  
  157. Bug reports, etc.
  158.  
  159.     We do appreciate feedback in the form of suggested improvements, bug 
  160.     reports, comments, corrections, suggestions, as well as sample programs
  161.     you've developed that may be worth distributing further.  Please direct
  162.     them to the address above.
  163.  
  164.     Thank you.  Have fun!
  165.